<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>nsamp</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="nrpn.html" title="nrpn" />
    <link rel="next" href="nstance.html" title="nstance" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">nsamp</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="nrpn.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="nstance.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="nsamp"></a>
      <div class="titlepage"></div>
      <a id="IndexNsamp" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">nsamp</span>
        </h2>
        <p>nsamp — 
      Returns the number of samples loaded into a stored function table number.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp127829232"></a>
        <h2>Description</h2>
        <p>
      Returns the number of samples loaded into a stored function table number.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp127830512"></a>
        <h2>Syntax</h2>
        <pre class="synopsis"><span class="command"><strong>nsamp</strong></span>(x) (init-rate args only)</pre>
      </div>
      <div class="refsect1">
        <a id="idp127895984"></a>
        <h2>Performance</h2>
        <p>
      Returns the number of samples loaded into stored function table number <span class="emphasis"><em>x</em></span> by GEN01. This is useful when a sample is shorter than the power-of-two function table that holds it. New in Csound version 3.49.
    </p>
        <p>
      As of Csound version 5.02, <span class="emphasis"><em>nsamp</em></span> works with deferred-length function tables (see
      <a class="link" href="GEN01.html" title="GEN01"><em class="citetitle">GEN01</em></a>).
    </p>
        <p>
      <span class="emphasis"><em>nsamp</em></span> differs from <span class="emphasis"><em>ftlen</em></span> in that <span class="emphasis"><em>nsamp</em></span> gives the number of sample frames loaded, while <span class="emphasis"><em>ftlen</em></span> gives the total number of samples. For example, with a stereo sound file of 10000 samples, ftlen() would return 19999 (i.e. a total of 20000 mono samples, not including a guard point), but nsamp() returns 10000.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp127902080"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the nsamp opcode. It uses the file <a class="ulink" href="examples/nsamp.csd" target="_top"><em class="citetitle">nsamp.csd</em></a>, <a class="ulink" href="examples/kickroll.wav" target="_top"><em class="citetitle">kickroll.wav</em></a>. and <a class="ulink" href="examples/fox.wav" target="_top"><em class="citetitle">fox.wav</em></a>.
      </p>
        <div class="example">
          <a id="idp127905520"></a>
          <p class="title">
            <strong>Example 548. Example of the nsamp opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
-odac     <span class="comment">;;;realtime audio out</span>
<span class="comment">;-iadc    ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o nsamp.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>
<span class="comment">; slightly adapted example from Jonathan Murphy Dec 2006</span>

<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 32
<span class="ohdr">nchnls</span> <span class="op">=</span> 2
<span class="ohdr">0dbfs</span>  <span class="op">=</span> 1

<span class="oblock">instr</span> 1

ifn   <span class="op">=</span>  p4	<span class="comment">; table number</span>
ilen  <span class="op">=</span>  <span class="opc">nsamp</span>(ifn)
<span class="opc">prints</span> "actual numbers of samples <span class="op">=</span> <span class="op">%</span>d\n", ilen
itrns <span class="op">=</span>  1	<span class="comment">; no transposition</span>
ilps  <span class="op">=</span>  0	<span class="comment">; loop starts at index 0</span>
ilpe  <span class="op">=</span>  ilen	<span class="comment">; ends at value returned by nsamp above</span>
imode <span class="op">=</span>  1	<span class="comment">; loops forward</span>
istrt <span class="op">=</span>  0	<span class="comment">; commence playback at index 0 samples</span>
<span class="comment">; lphasor provides index into f1 </span>
alphs <span class="opc">lphasor</span> itrns, ilps, ilpe, imode, istrt
atab  <span class="opc">tablei</span>  alphs, ifn
      <span class="opc">outs</span> atab, atab

<span class="oblock">endin</span>
<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>
<span class="stamnt">f</span> 1 0 262144 1 "kickroll.wav" 0 4 1	<span class="comment">;stereo file in table, with lots of zeroes</span>
<span class="stamnt">f</span> 2 0 262144 1 "<span class="stamnt">f</span>ox.wav" 0 4 1		<span class="comment">;mono file in table, with lots of zeroes</span>

<span class="stamnt">i</span>1 0 10 1
<span class="stamnt">i</span>1 + 10 2
<span class="stamnt">e</span>

<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
      Since the stereo audio file <span class="quote">“<span class="quote">kickroll.wav</span>”</span> has 37792 samples and the mono file <span class="quote">“<span class="quote">fox.wav</span>”</span> has 121569 samples, its output should include lines like these:
      </p>
        <pre class="screen">
actual numbers of samples = 37792
actual numbers of samples = 121569</pre>
        <p>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp127911488"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="ftchnls.html" title="ftchnls"><em class="citetitle">ftchnls</em></a>,
      <a class="link" href="ftlen.html" title="ftlen"><em class="citetitle">ftlen</em></a>,
      <a class="link" href="ftlptim.html" title="ftlptim"><em class="citetitle">ftlptim</em></a>,
      <a class="link" href="ftsr.html" title="ftsr"><em class="citetitle">ftsr</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp127916480"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Gabriel Maldonado</td>
          </tr>
          <tr>
            <td>Italy</td>
          </tr>
          <tr>
            <td>October 1998</td>
          </tr>
        </table>
        <p>
    </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="nrpn.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="nstance.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">nrpn </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> nstance</td>
        </tr>
      </table>
    </div>
  </body>
</html>
